Skip to content

CI: Infer PR context for format workflow - #11628

Merged
Rbb666 merged 1 commit into
RT-Thread:masterfrom
CYFS3:pr-format-context
Aug 12, 2026
Merged

CI: Infer PR context for format workflow#11628
Rbb666 merged 1 commit into
RT-Thread:masterfrom
CYFS3:pr-format-context

Conversation

@CYFS3

@CYFS3 CYFS3 commented Jul 17, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

拉取/合并请求描述：(PR description)

为什么提交这份PR (why to submit this PR)

当前格式化工作流要求贡献者同时填写 PR 分支和 PR 编号。GitHub 无法通过工作流链接自动填充 workflow_dispatch 输入，贡献者需要重复查找并填写 PR 编号，操作容易出错。

此外，自动格式化提交需要正确关联到 PR 作者，否则 GitHub 只显示同名字符串，无法识别为贡献者本人，也可能影响 CLA 检查。

你的解决方案是什么 (what is your solution)

  • 保留必填的 branch 输入，贡献者只需填写 PR 分支。
  • 根据当前仓库、父仓库、仓库所有者和分支自动查找唯一的开放 PR，无需填写 PR 编号。
  • 格式化结果生成独立的 style: format code with clang-format [skip ci] 提交，并通过普通 push 更新 PR 分支。
  • 使用 PR 作者的 GitHub 用户 ID 和登录名生成官方 noreply 邮箱，使格式化提交正确关联到贡献者账号。
  • Bot 评论明确说明 Use workflow from 保持默认分支，并在 branch 输入框填写 PR 分支。
  • Bot 评论在 PR 创建、重新打开及单提交同步时更新，避免重复评论。

请提供验证的bsp和config (provide the config and bsp)

当前拉取/合并请求的状态 Intent for your PR

必须选择一项 Choose one (Mandatory):

  • 本拉取/合并请求是一个草稿版本 This PR is for a code-review and is intended to get feedback
  • 本拉取/合并请求是一个成熟版本 This PR is mature, and ready to be integrated into the repo

代码质量 Code Quality：

我在这个拉取/合并请求中已经考虑了 As part of this pull request, I've considered the following:

  • 已经仔细查看过代码改动的对比 Already check the difference between PR and old code
  • 代码风格正确，包括缩进空格，命名及其他风格 Style guide is adhered to, including spacing, naming and other styles
  • 没有垃圾代码，代码尽量精简，不包含#if 0代码，不包含已经被注释了的代码 All redundant code is removed and cleaned up
  • 所有变更均有原因及合理的，并且不会影响到其他软件组件代码或BSP All modifications are justified and not affect other components or BSP
  • 对难懂代码均提供对应的注释 I've commented appropriately where code is tricky
  • 代码是高质量的 Code in this PR is of high quality
  • 已经使用clang-format 源码格式化工具确保格式符合RT-Thread代码规范 This PR has been formatted with clang-format and complies with RT-Thread code specification
  • 如果是新增bsp, 已经添加ci检查到.github/ALL_BSP_COMPILE.json 详细请参考链接BSP自查

@github-actions

github-actions Bot commented Jul 17, 2026

Copy link
Copy Markdown

👋 感谢您对 RT-Thread 的贡献！Thank you for your contribution to RT-Thread!

为确保代码符合 RT-Thread 的编码规范，请在你的仓库中执行以下步骤运行代码格式化工作流（如果格式化CI运行失败）。
To ensure your code complies with RT-Thread's coding style, please run the code formatting workflow by following the steps below (If the formatting of CI fails to run).

🛠 操作步骤 | Steps

  1. 前往 Actions 页面 | Go to the Actions page
    点击进入工作流 → | Click to open workflow →

  2. 点击 Run workflow | Click Run workflow

  • 设置需排除的文件/目录（目录请以"/"结尾）
    Set files/directories to exclude (directories should end with "/")
  • 将目标分支设置为 \ Set the target branch to：pr-format-context
  • 设置PR number为 \ Set the PR number to：11628
  1. 等待工作流完成 | Wait for the workflow to complete
    格式化后的代码将自动推送至你的分支。
    The formatted code will be automatically pushed to your branch.

完成后，提交将自动更新至 pr-format-context 分支，关联的 Pull Request 也会同步更新。
Once completed, commits will be pushed to the pr-format-context branch automatically, and the related Pull Request will be updated.

如有问题欢迎联系我们，再次感谢您的贡献！💐
If you have any questions, feel free to reach out. Thanks again for your contribution!

@github-actions github-actions Bot added the action github action yml imporve label Jul 17, 2026
@github-actions

github-actions Bot commented Jul 17, 2026 •
edited
Loading

Copy link
Copy Markdown

📌 Code Review Assignment

🏷️ Tag: workflow

Reviewers: @Rbb666 @kurisaW @supperthomas

Changed Files (Click to expand)
  • .github/workflows/pr_clang_format.yml
  • .github/workflows/pr_format_bot.yml

📊 Current Review Status (Last Updated: 2026-08-12 11:41 CST)

📝 Review Instructions

  1. 维护者可以通过单击此处来刷新审查状态: 🔄 刷新状态
    Maintainers can refresh the review status by clicking here: 🔄 Refresh Status

  2. 确认审核通过后评论 LGTM/lgtm
    Comment LGTM/lgtm after confirming approval

  3. PR合并前需至少一位维护者确认
    PR must be confirmed by at least one maintainer before merging

ℹ️ 刷新CI状态操作需要具备仓库写入权限。
ℹ️ Refresh CI status operation requires repository Write permission.

@CYFS3
CYFS3 marked this pull request as ready for review July 17, 2026 01:35
@kurisaW

kurisaW commented Jul 20, 2026

Copy link
Copy Markdown
Member

format commit不建议直接和用户commit合并，会对代码审查人员带来额外的压力，建议考虑：如果PR中存在多笔format commit，看看有没有什么机制只会生成最终的一条format commit

@CYFS3
CYFS3 force-pushed the pr-format-context branch from f4656fe to a257f24 Compare August 12, 2026 03:10
@CYFS3

CYFS3 commented Aug 12, 2026

Copy link
Copy Markdown
Contributor Author

format commit不建议直接和用户commit合并，会对代码审查人员带来额外的压力，建议考虑：如果PR中存在多笔format commit，看看有没有什么机制只会生成最终的一条format commit

已修改回原本的追加一条commit

@CYFS3
CYFS3 force-pushed the pr-format-context branch from a257f24 to 59a61ce Compare August 12, 2026 03:15
@Rbb666 Rbb666 closed this Aug 12, 2026
@Rbb666 Rbb666 reopened this Aug 12, 2026
@Rbb666
Rbb666 merged commit e591033 into RT-Thread:master Aug 12, 2026
8 of 19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@supperthomas supperthomas supperthomas approved these changes
@Rbb666 Rbb666 Rbb666 approved these changes
@kurisaW kurisaW Awaiting requested review from kurisaW kurisaW is a code owner

Assignees

No one assigned

Labels

action github action yml imporve

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@CYFS3 @kurisaW @supperthomas @Rbb666